home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat3 / ssapi.z / ssapi
Text File  |  1998-10-30  |  5KB  |  133 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSAAAAPPPPIIII((((3333))))                                                              SSSSSSSSAAAAPPPPIIII((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ssrt_caliper_point, ssrt_interface_routine, ssrt_buffer_clear - SpeedShop
  10.      runtime library
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<SSSSppppeeeeeeeeddddSSSShhhhoooopppp////aaaappppiiii....hhhh>>>>
  14.      iiiinnnntttt ssssssssrrrrtttt____ccccaaaalllliiiippppeeeerrrr____ppppooooiiiinnnntttt((((iiiinnnntttt ffffllllaaaaggggssss,,,, cccchhhhaaaarrrr ****llllaaaabbbbeeeellll))));;;;
  15.      lllloooonnnngggg ssssssssrrrrtttt____iiiinnnntttteeeerrrrffffaaaacccceeee____rrrroooouuuuttttiiiinnnneeee((((iiiinnnntttt oooopppp,,,, vvvvooooiiiidddd ****ccccoooonnnntttteeeexxxxtttt))));;;;
  16.      vvvvooooiiiidddd ssssssssrrrrtttt____bbbbuuuuffffffffeeeerrrr____cccclllleeeeaaaarrrr((((vvvvooooiiiidddd))));;;;
  17.      vvvvooooiiiidddd ssssssssrrrrtttt____eeeexxxxppppeeeerrrriiiimmmmeeeennnntttt____ssssttttoooopppp((((vvvvooooiiiidddd))));;;;
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      The SpeedShop Performance Tools work by invoking functions in the
  21.      SpeedShop runtime library.  This library may be explicitly linked with a
  22.      user program, in which case the following named routines above may be
  23.      invoked explicitly.  To explicitly link with the SpeedShop runtime, add
  24.      the option -_l_s_s to the link line used to build the program.  Doing so
  25.      will load the two SpeedShop libraries, _l_i_b_s_s._s_o and _l_i_b_s_s_r_t._s_o into the
  26.      executable.
  27.  
  28.      ssssssssrrrrtttt____ccccaaaalllliiiippppeeeerrrr____ppppooooiiiinnnntttt is used to record a caliper point in the experiment.
  29.      It may be called from anywhere in the code.  The first parameter
  30.      specifies the caliper point flags, but is not supported yet, so it's
  31.      ignored.  The second argument specifies a string label for the caliper
  32.      point.
  33.  
  34.      An implicit caliper point is always recorded at the start of execution of
  35.      the process. A final caliper point is recorded when the process exits
  36.      normally. The implicit caliper point at the beginning of the program is
  37.      numbered 0, the first caliper point after that is numbered 1, and any
  38.      additional caliper points are numbered sequentially.  In addition,
  39.      caliper points are automatically recorded under the following
  40.      circumstances to ensure that at least one valid set of data is recorded.
  41.  
  42.      - When a fatal or exit signal is received.
  43.  
  44.      - When the program calls an _e_x_e_c function.
  45.  
  46.      - When a program closes a DSO by calling _d_l_c_l_o_s_e().
  47.  
  48.      ssssssssrrrrtttt____iiiinnnntttteeeerrrrffffaaaacccceeee____rrrroooouuuuttttiiiinnnneeee is used to invoke the capture-module interface
  49.      routine.  The definitions for _o_p and the structure of _c_o_n_t_e_x_t for each
  50.      value of _o_p will be documented in future releases.
  51.  
  52.      ssssssssrrrrtttt____bbbbuuuuffffffffeeeerrrr____cccclllleeeeaaaarrrr is used to clear all currently accumulated data,
  53.      resetting all values to zero.  It is used to exclude data from an
  54.      initialization phase of the program.  With caliper support available in
  55.      prof(1), this routine will normally not be used.
  56.  
  57.      ssssssssrrrrtttt____eeeexxxxppppeeeerrrriiiimmmmeeeennnntttt____ssssttttoooopppp is used to disable performance data collection for
  58.      the calling process.  No experiment file will get generated for the
  59.      process either.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSAAAAPPPPIIII((((3333))))                                                              SSSSSSSSAAAAPPPPIIII((((3333))))
  71.  
  72.  
  73.  
  74. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  75.      speedshop(1), ssrun(1), prof(1), ssdump(1), ssapi(3F)
  76.  
  77. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  78.      As ouput from the library routines.
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.